Get

Function

This API is used to get the AI > Recognition > PlateGroup license plate group.

Request Message

Parameter Description

Table 1

Sample:

POST /API/AI/PlateGroup/Get HTTP/1.1

{
	"data": {
		"MsgId": "",
		"DefaultVal": 0,
		"SimpleInfo": 1,
"GroupsId": [
            1,
            2,
            3，
			…
        ]
	}
}

Response Message

Parameter Description

Table 2

Table 3

Table 4 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Id || int |License plate group ID | |Name |" Allow List"
" Block List "
…... |string |License plate group name, the group name can be customized, cannot be the same name | |DetectType |2 |int |Fixed to 2 (DLDT_Plate) | |Policy| 0-2 |int |Policy attribute: 0-Allow List, 1-Block List, 2-Unknown | |Enabled| 0,1 |int |License plate alarm Enable 0: off 1: on | |CanDel |0,1| int |A predefined group cannot be deleted and is identified by the CanDel field. 0 cannot be deleted | |Similarity |0-4| unsigned int| Fault tolerance rate: indicates the maximum number of characters that are allowed to make errors. For example, 0 indicates zero tolerance. All characters must be matched | |PolicyConfigs ||JSON array |Group alarm policy configuration, fixed to 2 elements, only the 0th element is used, the first element is discarded. PolicyConfigs JSON show as followTable 5| |EnableChnAlarm| [255, 255, 255, 255]| array |Control the channels in which the corresponding group is allowed to alarm, according to the bit bit position indicates that the corresponding channel is allowed to alarm | |AlarmOut || Object|Alarm output association Information JSON show as follow Table 6|

Table 5 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |ChnAlarmOut |[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255, 0, 255] ],
...
[ [255, 255, 0, 255], [255, 255, 0, 255], [255, 255,0,255] ] |array |Each element represents the alarm output associated with a channel, there are 3 main elements, the 0 th represents the local alarm output, the 1/2 represents the front-end alarm output 0/1, and each bit of the child element indicates whether the alarm output of the channel is associated | |ChnBuzzerOpt| [0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 …] |array |Each element indicates the buzzer configuration of a channel, 0-disable, 1-10s, 2-20s, 3-40s, 4-60s | |LatchTimeOpt |[0, 1, 1, 2, 3, 4, 0, 1, 1, 3, 2, 2 …]| array |Each element represents the alarm output duration of a channel, 0-0s, 1-1s, 2-2s, 3-3s, 4-5s, 5-10s, 6-20s, 7-40s, 8-60s | |SaveImg |[255, 255, 255, 255…] |array |Each element represents the configuration of whether a channel saves pictures, and the use of bits in each element indicates whether to save faces and backgrounds | |SendEmail |[0, 0, 0, 0] |array |Used in bits, each bit indicates whether a channel sends mail,0- not to send, 1- to send | |UploadToFtp |[255, 255, 255, 255]| array |Each bit indicates whether a channel uploads FTP | |UploadToCloud |[0, 0, 0, 0]| array |Used in bits, each bit indicates whether a channel is uploading to the Cloud, 0- not uploading, 1- uploading | |ShowThumbnail| [255, 255, 255, 255] |array |Used in bits, each bit represents a channel that is displayed as a thumbnail | |Record| [255, 255, 255, 255] |array |Used in bits, each bit indicates that a channel is recording | |Push |[0, 0, 0, 0]| array |Used by bit, each bit indicates whether a channel sends push, 0- no push, 1- push | |AlarmSchedule| [[255, 255, 255, 255, 255, 255],...],
[[255, 255, 255, 255, 255, 255] ...]|array |Alarm schedule, each bit represents half an hour, a total of 48 bits, set indicates video, and vice versa |

Table 6 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Local|"Local->1"
"Local->2"
"Local->3"
……
The number of local's depends on the capability of the device.| string array |Local alarm linkage.| |Ipc|| JSON array |Front-end alarm linkage. IPC JSON show as follow Table 7|

Table 7 |Parameter|Range|Type|Description| | ---- | ---- | ---- | ---- | |Channel || int| Front-end alarm output associated channel | |AlarmOutCnt || int| Indicates the number of front-end alarm outputs, front-end support 2 alarm outputs |

Tips:

Response messages and request messages may not contain all the fields in the table above. If no fields are included, the device does not support this parameter configuration.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": {
        "channel": [
            "CH1",
            "CH2",
            "CH3",
			...
        ],
        "Result": 0,
        "Count": 4,
        "Group": [
            {
                "Id": 1,
                "Name": "白名单",
                "Policy": 0,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
            {
                "Id": 2,
                "Name": "黑名单",
                "Policy": 1,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
            {
                "Id": 3,
                "Name": "未知",
                "Policy": 2,
                "DetectType": 2,
                "Similarity": 1,
                "CanDel": 0,
                "Enabled": 1,
                "EnableAlarm": 1
            },
			...
        ]
    }
}

Error Code

See Response Messages Body and Common error_code for more information.